Add usage snippets for Google Health AI models #1084
Conversation
…ation models (Google Health AI), to improve their Hugging Face Hub pages and ease model adoption
…gle-hai-libraries
ndebuhr
requested review from
SBrandeis,
gary149,
Wauplin,
julien-c,
pcuenca and
ngxson
as code owners
There was a problem hiding this comment.
Thanks for the PR @ndebuhr - re: both snippets:
- Both should actually be snippets (we discourage putting URLs to notebooks etc)
- For the other code snippet, we try to put the least possible lines of code that someone can understand/ work with. So would be great to reduce it.
Otherwise, I think I think this information can be nicely fit in the Model Card.
…gle-hai-libraries
…mage preprocessing and embeddings computation, not post-processing/visualization
|
@Vaibhavs10 I can collapse some lines or remove some comments to further reduce the LOC, but I think that would impact readability (especially in the relatively low-width snippet modal). Hoping this second pass is better? |
…tilizes CxrClient make_hugging_face_client
| @@ -95,6 +95,26 @@ export const bm25s = (model: ModelData): string[] => [ | |||
| retriever = BM25HF.load_from_hub("${model.id}")`, | |||
| ]; | |||
|
|
|||
| export const cxr_foundation = (model: ModelData): string[] => [ | |||
| `# Install library | |||
There was a problem hiding this comment.
I think we can remove the install instructions completely from here and keep them in the model card (As they are currently and just start from from PIL import Image
There was a problem hiding this comment.
Since we aren't doing a "typical" installation (e.g., pip install from PyPI or git), I'm a bit concerned about pulling that information out of the snippet. I think people will make assumptions that aren't true. Basically, there's no way somebody is going to correctly use the library or guess the installation without this, so I'd really prefer we keep that critical information in the snippet (as it looks like some other libraries have done). Is that fair?
Adding usage snippets to improve Hugging Face Hub model pages for CXR Foundation and Derm Foundation - improving usability via example Python code and linked Jupyter notebooks. Doing this at the model library level, to complement the usage documentation in the model cards, so that the "Use this model" Hub button provides useful information (currently "integration status unknown").